home *** CD-ROM | disk | FTP | other *** search
/ Compendium Deluxe 1 / LSD Compendium Deluxe 1.iso / a / programming / assembly / eurostars2.0.lha / ES.doc < prev    next >
Encoding:
Text File  |  1992-10-18  |  4.5 KB  |  128 lines
  1. ES                                                                         ES
  2.  
  3.    NAME
  4.     ES -- EuroStars
  5.  
  6.    SYNOPSIS
  7.     ES [MRS][XYZ] <value> [<value> ... ]
  8.     ES B
  9.     ES Q    (ARexx only)
  10.  
  11.    DESCRIPTION
  12.     ES is a starfield program based on European code that has been
  13.     massively cleaned up and featurized.  As a result, it doesn't run
  14.     quite as smoothly on vanilla 68000-based systems, but it's less
  15.     likely to trash your system.
  16.  
  17.     ES may be run from the command line or from the Workbench.  When
  18.     you're finished looking, click either mouse button anywhere on the
  19.     starfield to exit.
  20.  
  21.     ES lets you specify how the stars move and rotate.  This is done
  22.     from the command line, Workbench ToolTypes, or from the ARexx port.
  23.     For all, the argument syntax is the same.
  24.  
  25.    ARGUMENTS
  26.     The M, R, and S operators specify star movement, rotation, and spin
  27.     respectively.  Movement specifies how many world units the stars are
  28.     translated each frame.  Rotation specifies a static/initial rotation
  29.     angle.  Spin specifies the change in rotation for each frame.  The
  30.     X, Y, and Z specifiers indicate which axes the operators are to
  31.     apply.  Rotation angles are specified in "EuroHackerGrads."  There
  32.     are 2048 EHG to a full 360 degree circle.
  33.  
  34.     The MRS operators must appear before the the XYZ specifiers, and
  35.     there may be no spaces between them.  Only one MRS operator may
  36.     appear before a given set of XYZ specifiers.  Following the MRSXYZ
  37.     command are the actual values to be used.
  38.  
  39.     It's much easier to understand if you look at the examples.
  40.  
  41.     In addition to the above, there are two additional arguments that
  42.     may be used:
  43.  
  44.     B:    Operate as background server.
  45.         Ordinarily, ES will exit when you click on its screen.
  46.         However, if you want to do extensive ARexx operations
  47.         without user interference, this option may be specified,
  48.         causing ES to ignore all subsequent mouse events on its
  49.         screen.  Once backgrounded, ES cannot be un-backgrounded.
  50.         The only way to terminate a backgrounded ES is with the
  51.         following command:
  52.  
  53.     Q:    Quit.
  54.         When sent as an ARexx command, ES will exit immediately.
  55.         This option on the CLI command line is meaningless; if
  56.         present, the entire command line is ignored.
  57.  
  58.    WORKBENCH
  59.     ES recognizes Workbench ToolTypes when started from Workbench.  The
  60.     ToolType strings are identical to the command line arguments.
  61.     Multiple ToolType strings may be present in the icon; each one will
  62.     be processed in turn.  Project icons and multiple icon selection are
  63.     also supported; thus, you can have several "canned" starfields ready
  64.     to go from a Workbench window.
  65.  
  66.     Like ARexx commands (see below), the effect of multiple command
  67.     strings is cumulative.
  68.  
  69.    AREXX
  70.     ES features an ARexx port.  The name of the port is EUROSTARS.
  71.     Commands sent to this port are exactly the same as arguments on the
  72.     command line.  Malformed commands are returned with RC set to
  73.     RC_ERROR (10).
  74.  
  75.     Commands are cumulative; that is, a move command (for example)
  76.     remains in effect until reset by another move command for the same
  77.     axis.  Thus, an MX command followed later by an SX command does not
  78.     cancel the MX command.
  79.  
  80.    EXAMPLES
  81.     ES mx 4
  82.         Move stars 4 units along X axis each frame.
  83.     ES sxyz 2 -4 6
  84.         For each frame, spin the X axis 2 EHG, the Y axis -4 EHG,
  85.         and the Z axis 6 EHG.
  86.     ES rx 512
  87.         Rotate X axis 512 EHG and keep it there.
  88.     ES rx -512 sx 2
  89.         Start X axis rotated at -512 EHG and add 2 EHG to it each
  90.         frame.
  91.     ES mxz 10 0 sxyz 1 1 1
  92.         Move 10 units along X, zero units along Z, and spin all axes
  93.         by one EHG each frame.
  94.     ES mxz sxyz 10 0 1 1 1
  95.         Identical to the above.
  96.     ES sxmxsymzsz 1 10 1 0 1
  97.         Again, identical to the above.
  98.  
  99.     As you can see, the syntax is very flexible.
  100.  
  101.    NOTES
  102.     Despite its nomenclature, the 'B' option does not fork ES into the
  103.     background; you must use the 'Run' command.
  104.  
  105.     The coordinate system is right-handed, X axis horizontal, Y axis
  106.     vertical, Z axis perpendicular to the screen.  Positive rotations
  107.     are clockwise, and are in Z,Y,X order.
  108.  
  109.     The default startup values are:
  110.     MX 0  MY 0  MZ 4   RX 0  RY 0  RZ 0   SX 0  SY 0  SZ 0
  111.  
  112.    BUGS
  113.     Though vastly improved for v2.0, it's still a bit slow on 68000-
  114.     based systems.
  115.  
  116.     Malformed commands generate a diagnostic string to the CLI.  These
  117.     strings are not available to ARexx programs or if the program is
  118.     started from Workbench.  The latter can be particularly annoying, as
  119.     malformed ToolType strings will cause ES to silently refuse to
  120.     start.  Sigh...
  121.  
  122.    AUTHOR
  123.     Leo L. Schwab  --  New Technologies Group, Inc.
  124.     BIX:        ewhac
  125.     Portal:        ewhac
  126.     InterNet:    ewhac@ntg.com   ..or..   ewhac@well.sf.ca.us
  127.  
  128.